revXMLRPC_AddParam

Type

command

Summary

Adds a single parameter to an XML-RPC document structure.

Syntax

revXMLRPC_AddParam <XMLRPCdocumentID>, <dataType>, <dataValue>

Description

Use the revXMLRPC_AddParam command to add a single parameter of a given type to an existing XML-RPC document.

To pass an array of data, you have to pass the type as well, in the following format:

    array[:elementType]

For example:

    local theArray
    repeat with i = 1 to 10
        put random(100) into theArray[i]
    end repeat
    revXMLRPC_AddParam theDocID, \"array:int\", theArray

If you do not specify an element type, the revXMLRPC_AddParam command assumes you're passing an array of strings.

If you need to add complex parameters (such as arrays of various types, or structs) you can specify a dataType of xml, and pass raw xml.

Parameters

Name	Type	Description
XMLRPCdocumentID	integer	The number returned by the revXMLRPC_CreateRequest when you created the XML-RPC request.
dataType	enum	The type of data contained in the dataValue parameter.
dataValue	string	The content of the data you want to add as a new parameter.

Examples

revXMLRPC_AddParam theRequest, "int", 55

revXMLRPC_AddParam theRequest, "base64", base64Encode(theBinaryData)

put "<struct>" & \
    "<member><name>left</name>" & \
    "<value><int>10</int></value></member>" & \
    "<member><name>top</name>" & \
    "<value><int>50</int></value></member>" & \
    "<member><name>right</name>" & \
    "<value><int>390</int></value></member>" & \
    "<member><name>bottom</name>" & \
    "<value><int>240</int></value></member>" & \
    "</struct>" into theStruct
revXMLRPC_AddParam theDocID, "xml", theStruct

Related

glossary: Standalone Application Settings, standalone application, command, XML-RPC document, LiveCode custom library, XML-RPC

library: XML-RPC library

function: revXMLRPC_GetParamType, revXMLRPC_GetParam, result, revXMLRPC_GetParamCount, revXMLRPC_CreateRequest

Compatibility and Support

Introduced

LiveCode 2.5

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile